/**
 * Copyright (c) 2008, Andrew Carter
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification, are 
 * permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list of 
 * conditions and the following disclaimer. Redistributions in binary form must reproduce 
 * the above copyright notice, this list of conditions and the following disclaimer in 
 * the documentation and/or other materials provided with the distribution. Neither the 
 * name of Andrew Carter nor the names of contributors may be used to endorse or promote 
 * products derived from this software without specific prior written permission. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT 
 * SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT 
 * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.acarter.scenemonitor.textdescriptor;

import java.text.DecimalFormat;

import javax.swing.text.BadLocationException;
import javax.swing.text.StyledDocument;

import com.jme.math.Quaternion;
import com.jme.math.Vector3f;
import com.jme.renderer.ColorRGBA;

/**
 * Defines the basic functionality for creating descriptors.
 * 
 * @author Carter
 */
public abstract class A_TextDescriptor {
	
	/** A decimal formatter */
	protected DecimalFormat decimal = new DecimalFormat("#####.####");
	
	/**
	 * Erases all text from the document.
	 * 
	 * @param infoDocument
	 * @throws BadLocationException 
	 */
	protected final void clearDocument(StyledDocument infoDocument) throws BadLocationException {
	
		infoDocument.remove(0, infoDocument.getLength());
	}
	
	/**
	 * Writes a string to the document.
	 * 
	 * @param infoDocument
	 * @param string
	 * @param style
	 * @throws BadLocationException
	 */
	protected final void writeString(StyledDocument infoDocument, String string, String style) throws BadLocationException {
		
		infoDocument.insertString(infoDocument.getLength(), string, infoDocument.getStyle(style));
	}
	
	/**
	 * Called when the text should be replaced with more current information.
	 * 
	 * @param infoDocument
	 * @param object
	 */
	public abstract void updateInfo(StyledDocument infoDocument, Object object);
	
	/**
	 * Convenience method for converting a vector to a string.
	 * 
	 * @param vector
	 * @return
	 */
	protected String toString(Vector3f vector) {
		if(vector != null)
			return "( " + decimal.format(vector.x) + ", " + decimal.format(vector.y) + ", " + decimal.format(vector.z) + " )";
		else
			return "null";
	}
	
	/**
	 * Convenience method for converting a quaternion to a string.
	 * 
	 * @param quat
	 * @return
	 */
	protected String toString(Quaternion quat) {
		
		if(quat != null)
			return "( " + decimal.format(quat.x) + ", " + decimal.format(quat.y) + ", " + decimal.format(quat.z) + ", " + decimal.format(quat.w) + " )";
		else
			return "null";
	}
	
	/**
	 * Convenience method for converting a color to a string.
	 * 
	 * @param color
	 * @return
	 */
	protected String toString(ColorRGBA color) {
		
		if(color != null)
			return "( " + decimal.format(color.r) + ", " + decimal.format(color.g) + ", " + decimal.format(color.b) + ", " + decimal.format(color.a) + " )";
		else
			return "null";
	}
}
